Add typechecking #15
Merged
Add typechecking #15
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR improves type safety and streamlines initialization by integrating type checking into the CI pipeline, refactoring code to remove unused parameters, and adding type stubs for enhanced development support.
- Added a new type checking job in the CI workflow and corresponding Makefile target.
- Removed the unused datastore parameter from Logger initializations in both main.py and repl.py.
- Introduced type stubs in the typings directory (for the board and gc modules) and updated dependency configurations.
Reviewed Changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| typings/gc.pyi | Added type stubs for the garbage collector functionality. |
| typings/board.pyi | Introduced board-specific type definitions and pin mappings. |
| repl.py | Removed the unused datastore parameter from Counter usage. |
| pyproject.toml | Added pyright dependency and configured typechecking. |
| main.py | Updated type annotations and removed unused method calls. |
| .github/workflows/ci.yaml | Added a new typecheck job to the CI pipeline. |
Files not reviewed (1)
- Makefile: Language not supported
JamesDCowley
approved these changes
Apr 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This pull request introduces several changes to improve type safety. The most significant updates include adding type checking to the CI pipeline, refactoring code to remove unused parameters, and adding type stubs for better development support.
CI and Build Process Enhancements:
typecheckjob to the CI pipeline in.github/workflows/ci.yamlto ensure type safety usingpyright.typechecktarget in theMakefileto run type checks locally withpyright.Code Refactoring:
datastoreparameter fromCounterandFlaginstances inmain.pyandrepl.pyto simplify their initialization. [1] [2] [3]spi0variable inmain.pyto explicitly declare its type asSPI.f.all_face_data()andf.send_face()) in themain()function to clean up unused functionality.Dependency and Configuration Updates:
pyright[nodejs]as a development dependency inpyproject.tomlto enable type checking.pyrightinpyproject.tomlwith include/exclude paths, stub paths, and module reporting options for type checking.New Type Stubs:
typings/board.pyifor board-specific definitions, including pin mappings and busio objects.typings/gc.pyito provide type hints for the garbage collector module.How was this tested